Repository navigation
docs: tidy comments, docstrings and the STATUS caveats - #14
Merged
Merged
Conversation
Comments and docstrings only; the AST of every touched file is unchanged once docstrings are removed, and the suite passes (226 passed, 4 skipped). Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
planetf1
force-pushed
the
docs/tidy-comments-and-docs
branch
from
October 25, 2026 20:49
6a42330 to
e1f4050
Compare
planetf1
marked this pull request as ready for review
October 25, 2026 20:50
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Comments and docstrings are shorter and no longer use dashes as separators. No behaviour change: the AST of every touched Python file is identical once docstrings are removed, and the suite passes (226 passed, 4 skipped).
docs/STATUS.mdgets the Decision Index caveats split into short bullets.Stacked on #13 (base is its branch) so the two do not conflict; retarget to
mainafter #13 merges. Draft.